package com.boat.starter.mockit.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.core.annotation.AliasFor;

import io.swagger.v3.oas.annotations.Parameter;

/**
 * 标识需要放在query上的参数，是适合用于简单类型
 * @author 周江
 *
 */
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Parameter
public @interface MockRequestQuery {
	/**
	 * Alias for {@link Parameter#name}.
	 */
	@AliasFor(annotation = Parameter.class, attribute = "name")
	String name() default "";

	/**
	 * Alias for {@link Parameter#description}.
	 */
	@AliasFor(annotation = Parameter.class, attribute = "description")
	String description() default "";

	/**
	 * Alias for {@link Parameter#example}.
	 */
	@AliasFor(annotation = Parameter.class, attribute = "example")
	String example() default "";
}
